From: Jonathan Lebon <jonathan@jlebon.com>
Date: Mon, 30 Apr 2018 12:53:01 +0000 (-0400)
Subject: man/ostree: Document --repo option a bit more
X-Git-Tag: archive/raspbian/2022.1-3+rpi1~1^2~205^2^2~23
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=54c5ab76a94bebc647cb0d80652f8d9980a2fa4d;p=ostree.git

man/ostree: Document --repo option a bit more

This new information is already mostly part of `ostree.repo(5)`, though
let's put it in `ostree(1)` as well since that's where the switch is
officially documented.

Closes: #1560
Approved by: cgwalters
---

diff --git a/man/ostree.xml b/man/ostree.xml
index 8a79cd04..f8d3e2fc 100644
--- a/man/ostree.xml
+++ b/man/ostree.xml
@@ -111,14 +111,14 @@ Boston, MA 02111-1307, USA.
                 <term><option>--repo</option></term>
 
                 <listitem><para>
-                    For most commands,
-                    when run as non-root, repository is
-                    required.  If
-                    <command>ostree</command> is run as
-                    root, it is assumed operations will be
-                    performed on the
-                    <filename>/sysroot/ostree/repo</filename>
-                    repository.
+                    For most commands, a repository is
+                    required.  If unspecified, the current
+                    directory is used if it appears to be an
+                    OSTree repository. If it isn't, either
+                    the <envar>OSTREE_REPO</envar>
+                    environment variable is used, or the
+                    system repository located at
+                    <filename>/sysroot/ostree/repo</filename>.
                 </para></listitem>
             </varlistentry>
 
diff --git a/src/ostree/ot-main.c b/src/ostree/ot-main.c
index 237427a2..148c8371 100644
--- a/src/ostree/ot-main.c
+++ b/src/ostree/ot-main.c
@@ -46,7 +46,7 @@ static GOptionEntry global_entries[] = {
 };
 
 static GOptionEntry repo_entry[] = {
-  { "repo", 0, 0, G_OPTION_ARG_FILENAME, &opt_repo, "Path to OSTree repository (defaults to /sysroot/ostree/repo)", "PATH" },
+  { "repo", 0, 0, G_OPTION_ARG_FILENAME, &opt_repo, "Path to OSTree repository (defaults to current directory or /sysroot/ostree/repo)", "PATH" },
   { NULL }
 };